Help file for GoED.

@@Contents
HelpOnHelp : `1Help on Help`0
GoEdOver   : `1Editor Overview`0
@@SectionHdr :
@@SectionHdr :    `2Command Parameters`0
@@SectionHdr :
CmdLine    : `1Command line parameters`0
FileCmds   : `1Commands placed in first line of file`0
@@SectionHdr :
@@SectionHdr :    `2Edit Keys`0
@@SectionHdr :
CursKeys   : `1Cursor Movement`0
DelKeys    : `1Delete Keys`0
FnKeys     : `1Function Keys`0
MarkKeys   : `1Selecting Text`0
SearchKeys : `1Finding Text`0
MiscKeys   : `1Miscellaneous Keys`0
MacroKeys  : `1Macro Keys`0
File       : `1Managing Files`0
@@SectionHdr :
@@SectionHdr :    `2Miscellaneous Items`0
@@SectionHdr :
Colors     : `1Using Colors`0
MenuBar    : `1Menu Bar`0
@@EndContents



@@Help
[HelpOnHelp]
To use help, select the topic you want help on from the topics
list (enter 'T' to get back to the topics list). Use the
cursor and page keys to scroll through the text. The `2 Next`0
and `2 Previous `0 buttons move to the next and previous
topic, respectively.

All of the buttons in `1GoHelp`0 can be executed by simply
pressing the key that is highlighted on the button. You can
also TAB to the button or press it's accelerator key (press
<ALT> + key hightlighted on button label).

To get help on a particular program, run `1GoHelp`0 with the
first argument on the command line set: `1GoHome`0,
`1GoScript`0, `1GoSched`0, or `1GoEd`0. You can also run
`1GoHelp`0 with no arguments, in which case you will be
presented with a menu to select the program you want help on.

þ

[GoEdOver]
GoEd is a file editor that has several unique features that
make it different from other editors.  GoEd was designed to
be small in size but not in features, load files as quick as
possible, be able to define the number of rows and columns to
display, allow text to be assigned different colors, and to
be integrated in with GoHome to behave as a "pop-up" notepad.

GoEd functions like most text editors: it performs basic file
editing, search-and-replace, and goto line operations.  It
also provides several advanced features such as cut, copy,
and paste blocks of text, set tabs, set maximum line length,
set read-only mode, display control characters, and allows
text to be assigned to macro keys.  In addition, GoEd also
provides for characters to be displayed in different colors
and the width and height of the editor to be set.

þ

[CmdLine]
`1GoEd`0 provides a way to customize its behavior by using
command line arguments. As with all GoHome programs, command
line arguments may be placed in a config file. The default
config file for `1GoEd`0 is `2GOED.CFG`0. If a different
config file is used, it may be specified when starting
`1GoEd`0 with the argument "@configfile" where configfile
is replaced with the file name of the config file to use.

The syntax for starting `1GoEd`0 is

     GoEdit [parameters] filename                                   
                                                                        
Parameters                                                              
  /POS=row,col,width,height - position and size of edit window
  /FULL=[Y|N]     full screen edit window
  /SAVSCRN=[Y|N]  Save foreground screen (default is 'Y'). Use
                  `1/SAVSCRN=N`0 to increase editor capacity by
                  4,212 bytes.
  /IGGMDS=[Y|N]   Ignore any config commands in file
  /READ=[Y|N]     readonly
  /TAB=x          x is tab tab size (default 4) 
  /USECOLORS=[Y|N]  Use back quote as color attribute 
                  indicator
  /TEXT=x         x is text color attribute (ie. x=1B for 
                  cyan on blue)
  /STATUS=x       x is status line color (ie. x=5C for red on 
                  magenta) 
  /LEN=x          x is the maximum number of characters 
                  in a line      
  /FIND=x         x is a string to search and goto in the 
                  text file
  /GOTO=x         x is the line number to go to                        
  /CSET=[m|b|1,2,3,4]  Select color set 
                  (m->mono,b->B&W,other color)
  /PAL=x          use color palette x where is 1 or 
                  2 (VGA only).
  @configfile     Use command parameters in 'configfile'
þ


[FileCmds]
`1GoEd`0 may be configured differently depending on the
file. When `1GoEd`0 is reading in a file, it checks to see
if the first line starts with "GoEdCmds:". If it does, then
`1GoEd`0 will uses the parameters that follow it as the 
default edit parameters. For example, assume that the 
following line appeared as the first line in a file.

GoEdCmds: /POS=2,27,23,20  /READ /GOTO=2

The /POS=2,27,23,20 command would move the edit window to the
2nd row and the 27th column of the screen.  It also would set
the width of the editor to 23 characters and the height to 20
rows.  Screen coordinates start with one and go to the
maximum allowed by the screen (usually 25 rows and 80
columns).

The /READ command puts GoEd into read-only mode (i.e.  the
file cannot be edited).  To turn off read-only mode, press
"<Alt><O>" to pop-up the Options dialog.  Then press
"<Alt><R>" to move to the "Read only" field and remove the
check mark by pressing the space bar.  The file can now be
edited.

Finally, the /GOTO=2 command tells GoEd to move to the second
line of the file.  This will hide the commands in the first
line of the file.

GoEd also has a command line parameter, "/IGCMDS", that
tells it to ignore any commands in the first line of the file.

þ


[CursKeys]
The following keys are used to move the cursor around in
`1GoEd`0.

       Key        Action
    ----------------------------------------------
       Ä         Moves left one character
       Ä         Moves right one character
                 Moves up one line
                 Moves down one line
      Ctrl Ä     Moves to next word at right
      Ctrl Ä     Moves to next word at left
      Home        Moves to start of line
      End         Moves to end of line
      Ctrl+Home   Moves to top of window
      Ctrl+End    Moves to bottom of windows
      PgUp        Scrolls up one screenful
      PgDn        Scrolls up one screenful
      Ctrl+PgUp   Moves to beginning of file
      Ctrl+PgDn   Moves to end of file
      Ctrl+W      Scrolls up one line
      Ctrl+Z      Scrolls down one line
þ

[DelKeys]
       Key        Action
    ---------------------------------------------------
       Del        Delete character cursor is on 
       BkSpace    Delete char to left of cursor
       Ctl-T      Delete the word to right of cursor
       Ctl-D      Delete line cursor is on
       Ctl-Q      Delete to end of line                               

þ
 
[FnKeys]
       Key       Action
    ---------------------------------------------------
       F1        Show Help screen
       F2        Save the text to file
       F3        Exit the editor
       F4        Search for a piece of text (Find)
       F5        Repeat last search (Find Next)
       F6        Start marking a block        
       F7        Cut marked block           
       F8        Paste a block of text previous copied or cut
       F9        Display information about the file
       F10       Edit another file          

þ

[MarkKeys] 
To mark a block, move the cursor to the first line to be 
selected. Use the arrow keys to move the cursor to the last
line you want selected.  To cancel the selection, press <Esc>.

       Key        Action
    --------------------------------------------------------
       Ctl+M      Start marking a block 
       arrow keys Extend marked block      
       Ctl+C      Copy marked block to clipboard
       Ctl+V      Paste block from clipboard
       Ctl+X      Cut marked block to clipboard
 
þ

[SearchKeys]
       Key       Action
    ---------------------------------------------------
       Ctl+S    Search for text (Find)
       Ctl+L    Repeat last search (Find Next)
       Ctl+R    Find & replace text
       Ctl+G    Goto a line number  
þ

[MiscKeys]
       Key       Action
    ---------------------------------------------------
       Ctl+I    Display information about the file
       Ctl+O    Show Options dialog 
       Alt+H    Bring up the help system
       Alt+Z    Show color codes

þ

[MacroKeys]
GoEd allows you to define up to 10 `1Macro`0 keys. A `1Macro`0
key will insert a predefined text segment into the current 
cursor location. 

`1Macro`0 keys are assigned to the <Alt> number keys (<Alt><1>,
<Alt><2>, ..., <Alt><0>). They may be defined on the command 
line but are generally placed in the config file for `1GoEd`0
(i.e. GOED.CFG). `1GoEd`0 has 10 command line arguments for
each allowable macro key: /alt1, /alt2, ..., /alt0. The macro
strings must be enclosed in quotes. For example, if we want
to assign the string "Added Dimension Software, Inc." to
<Alt><1>, we would add the following line to GOED.CFG:

  /ALT1="Added Dimension Software, Inc."

Now, whenever the <Alt><1> keys are pressed, the above string
will be inserted into the text file. 

Macros may extend multiple lines. For example, we could assign
an address block to the <Alt><2> keys using the following line:

  /ALT2="John Doe
   1234 Anytown Ave.
   Burbsville, USA  54321
"

Note that the entire string is enclosed within quotes.

þ

[File]
       Key       Action
    ---------------------------------------------------
      Alt-S      Save text to file
      Alt-A      Save the text to another file name
      Alt-E      Edit another file

þ

[Colors]
`1GoEd`0 has a unique feature that allows text files to
display characters in different colors. These is handy to
highlight certain words in a file. For example, you may want
to have a file that lists the keys used by Word Perfect. You
could have the key sequence displayed in blue and the
description displayed in yellow.

GoEd uses the forward quote (``) to tell it to use the color
that corresponds with the number following it.  Note that
there are two single quotes on the keyboard, the forward
quote is the one that is typically just to the left of the
number 1 key and when the <Shift> key is pressed will display
a tilde (~) character.

To see a list of colors that are assigned to numbers, display
the "Show Colors" dialog (press <Alt><Z>). 

To have `1GoEd`0 interpret color codes, either start it with
the `2/USECOLORS`0 option or turn on colors by checking the
"Use color codes" check box in the `2Options`0 dialog.

For example, say we want to have a file that lists the
function keys used by `1GoEd`0. We want to use the color
assigned to number 5 to display the function keys and 
the color assigned to number 8 to display the description.
The file might look like this

GoEdCmds: /POS=2,12,48,14  /READ /GOTO=2 /USECOLORS
  Key       Action
---------------------------------------------------
  ``5F1``3        ``7Show Help screen``3
  ``5F2``3        ``7Save the text to file``3
  ``5F3``3        ``7Exit the editor``3
  ``5F4``3        ``7Search for a piece of text (Find)``3
  ``5F5``3        ``7Repeat last search (Find Next)``3
  ``5F6``3        ``7Start marking a block``3
  ``5F7``3        ``7Cut marked block``3
  ``5F8``3        ``7Paste a block of text``3
  ``5F9``3        ``7Display information about the file``3
  ``5F10``3       ``7Edit another file``3

Note that the first line contains parameters to size the
editor, put it in read-only mode, goto to the second line,
and turn on the ability to use colors.
þ

[MenuBar]
If GoEd is in full screen mode, a menu bar will be used.
If this is the case, some of the <Alt> key combinations 
will pull-down a menu instead of performing an action.
For example, in full screen mode the <Alt><O> keys will
pull-down the "Options" menu; if not in full screen mode,
then <Alt><O> will display the "Options" dialog.
þ



@@EndHelp

